Skip to content

Adding first example to svMultiPhysics User Guide - #111

Open
justran-csuf wants to merge 4 commits into
SimVascular:mainfrom
justran-csuf:100-creating-cfd-user-guide
Open

Adding first example to svMultiPhysics User Guide#111
justran-csuf wants to merge 4 commits into
SimVascular:mainfrom
justran-csuf:100-creating-cfd-user-guide

Conversation

@justran-csuf

Copy link
Copy Markdown

Current situation

This pull request is the first example to be added to the CFD User Guide. It contains a worked example of setting up a steady rigid wall simulation in a patient-specific geometry of the descending aorta and iliac artery. It goes through the logical steps one would take to set up a CFD simulation along with the necessary commands in the svMultiPhysics .XML input file needed to execute these. Explanations are added to give context as to why certain decisions are made as well as to teach users the basics of CFD and cardiovascular modeling. Simulation results are also discussed briefly to show users what they should be looking for.

Release Notes

  • Created a whole new page in the "documentation" folder called "svmp_user_guide" that has all of the markdown files needed for the example. Style of the markdown files was created using the style guide provided (i.e. creating separate folders for each markdown file, naming each file "readme.md", etc.)
  • Created a new HTML file within "documentation" that follows the provided template that displays all markdown files in the same page
  • User guide has not been linked to any other page in the documentation. It is currently in the review stage.

Documentation

  • This pull request only adds files to the "documentation" folder. No existing files have been modified.

Testing

  • Tested using the "Live Server" feature in Visual Studio and appears to look fine.

Code of Conduct & Contributing Guidelines

@ktbolt

ktbolt commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

@justran-csuf The CFD User Guide content should be placed under simvascular.github.io/documentation/multi_physics/user-guide with the other user guide content

cardiac_electrophysiology/	hemodynamics/			nonlinear_solid_dynamics/
fluid_solid_interaction/	material_models/		readme.md

@alisonmarsden

Copy link
Copy Markdown

I think now that we are only supporting one solver, it makes sense to document how to run simulations with all the different physics one may want to use: CFD, EP, mechanics, etc. All of these will now be done with svMultiPhysics. Some of this content is already in the "SimCardio" section, so we should break that up and move the content to the relevant sections (for example there is quite a nice description there on how to run an EP simulation which needs to be updated). See the google slide I sent a while back with a possible outline. We could have a header on running simulations with svMultiPhycis, and in the main menu then list all the different physics options in an easy to find manner.

@justran-csuf

Copy link
Copy Markdown
Author

@ktbolt Got it, I will move it to that folder. Should this content be in its own folder? Maybe simvascular.github.io/documentation/multi_physics/user-guide/cfd? I see now that the User Guide is currently part of the multi_physics.html file but commented out. That page is getting pretty crowded already with everything that is there. Did you want me to take a look and organize that page? I think it would be good to split that page into separate pages. The 'Theory' section can probably be a separate page since most users will likely not be looking at the governing equations.

@ktbolt

ktbolt commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

@justran-csuf It should be in its own folder. We will rearrange content later on.

@justran-csuf justran-csuf left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the second example to the CFD User Guide which covers unsteady simulations and RCR boundary conditions. I also moved all files into a "cfd" folder in the "user-guide" folder. I still kept an HTML file for staging purposes for me to check on the formatting, but will eventually delete this when this content is merged with the rest of the User Guide.

@ktbolt

ktbolt commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

@justran-csuf I don't see your content. Do you see it in a local browser ?

@ktbolt

ktbolt commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

@justran-csuf I don't see the User Guide section in the documentation, seems like that is commented out, so you wll need to uncomment it and add your section.

@justran-csuf

Copy link
Copy Markdown
Author

@ktbolt I added my CFD User Guide content to the main multi_physics.html. I also created a "svmp_user_guide_staging.hrml" file if you want to view the content separately.

@ktbolt

ktbolt commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

@justran-csuf You need to sync your fork with https://github.com/SimVascular/simvascular.github.io main branch.

@ktbolt

ktbolt commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

@justran-csuf Wait, I am not seeing the new menu organization using my local web browser. Do you see it ?

@justran-csuf

Copy link
Copy Markdown
Author

@ktbolt I am not sure how to check the new menu organization. I only have been changing files in the "documentation" folder and created my own .html file for staging. I created my fork a while ago when we deleted the branches off the main repository. How often should I be syncing my fork? I have just been focused on getting the content finished.

@ktbolt

ktbolt commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

@justran-csuf You should update your fork after you see a PR here.

Don't you use a local web server to see the changes that you've made ?

@ryanspilker Can you see the new menu organization using caddy ? I do see it if I load the index.html file in Chrome.

@ryanspilker

Copy link
Copy Markdown
Collaborator

@ktbolt The problem appears to be that Justin’s feature branch is behind the repository’s main branch. PR #111 was created before PRs #110 and #109 were merged. Merging current main into the PR branch should complete without conflicts and bring the new menu together with Justin’s CFD examples.

@justran-csuf First make sure git status reports no uncommitted changes. Then, in your local clone, run:

git remote -v
git fetch upstream
git switch main
git merge --ff-only upstream/main
git push origin main
git switch 100-creating-cfd-user-guide
git merge main
git push origin 100-creating-cfd-user-guide

If git remote -v does not list https://github.com/SimVascular/simvascular.github.io.git as upstream, add it before running git fetch upstream:

git remote add upstream https://github.com/SimVascular/simvascular.github.io.git

Afterward, preview the repository from its root, and open documentation/multi_physics.html. That page tests the shared menu and your CFD content together. Once it works there, the temporary staging HTML file can be removed.

@ktbolt

ktbolt commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

@ryanspilker My fork is synced but the web page still does not appear like the new organization when I use caddy. It looks fine when I load the index.html using Chrome so I guess I will use that.

@justran-csuf

Copy link
Copy Markdown
Author

Thanks @ryanspilker for the instructions. I think I did everything correctly... When I use the Live Server extension in Visual Studio on the "index.html", I can see the new table of contents. Then when I navigate to the svMultiPhysics page, I see my new content as well.

@ktbolt I have been using the Live Server extension in Visual Studio, but I was using it directly onto my staging file so I could view my content. I never tried using it on the index.html before now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants